<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilnvm: XilNvm APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilnvm
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xnvm__apis.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">XilNvm APIs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga1549af470b2278bd56555178fa8622b5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__apis.html#ga1549af470b2278bd56555178fa8622b5">XNVM_BBRAM_AES_KEY_LEN_IN_BITS</a>&#160;&#160;&#160;(256U)</td></tr>
<tr class="memdesc:ga1549af470b2278bd56555178fa8622b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">AES key length in Bits.  <a href="#ga1549af470b2278bd56555178fa8622b5">More...</a><br/></td></tr>
<tr class="separator:ga1549af470b2278bd56555178fa8622b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga063185be808d423aa306a8ab64e793e5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__apis.html#ga063185be808d423aa306a8ab64e793e5">XNVM_BBRAM_AES_KEY_LEN_IN_BYTES</a>&#160;&#160;&#160;(<a class="el" href="group__xnvm__apis.html#ga1549af470b2278bd56555178fa8622b5">XNVM_BBRAM_AES_KEY_LEN_IN_BITS</a> / 8U)</td></tr>
<tr class="memdesc:ga063185be808d423aa306a8ab64e793e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">AES key length in Bytes.  <a href="#ga063185be808d423aa306a8ab64e793e5">More...</a><br/></td></tr>
<tr class="separator:ga063185be808d423aa306a8ab64e793e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8160f563678d1f39b84bb7d30033b824"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__apis.html#ga8160f563678d1f39b84bb7d30033b824">XNVM_BBRAM_AES_KEY_STR_LEN</a>&#160;&#160;&#160;(<a class="el" href="group__xnvm__apis.html#ga1549af470b2278bd56555178fa8622b5">XNVM_BBRAM_AES_KEY_LEN_IN_BITS</a> / 4U)</td></tr>
<tr class="memdesc:ga8160f563678d1f39b84bb7d30033b824"><td class="mdescLeft">&#160;</td><td class="mdescRight">String length of Key.  <a href="#ga8160f563678d1f39b84bb7d30033b824">More...</a><br/></td></tr>
<tr class="separator:ga8160f563678d1f39b84bb7d30033b824"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1549af470b2278bd56555178fa8622b5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__apis.html#ga1549af470b2278bd56555178fa8622b5">XNVM_BBRAM_AES_KEY_LEN_IN_BITS</a>&#160;&#160;&#160;(256U)</td></tr>
<tr class="memdesc:ga1549af470b2278bd56555178fa8622b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">AES key length in Bits.  <a href="#ga1549af470b2278bd56555178fa8622b5">More...</a><br/></td></tr>
<tr class="separator:ga1549af470b2278bd56555178fa8622b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga063185be808d423aa306a8ab64e793e5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__apis.html#ga063185be808d423aa306a8ab64e793e5">XNVM_BBRAM_AES_KEY_LEN_IN_BYTES</a>&#160;&#160;&#160;(<a class="el" href="group__xnvm__apis.html#ga1549af470b2278bd56555178fa8622b5">XNVM_BBRAM_AES_KEY_LEN_IN_BITS</a> / 8U)</td></tr>
<tr class="memdesc:ga063185be808d423aa306a8ab64e793e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">AES key length in Bytes.  <a href="#ga063185be808d423aa306a8ab64e793e5">More...</a><br/></td></tr>
<tr class="separator:ga063185be808d423aa306a8ab64e793e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8160f563678d1f39b84bb7d30033b824"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__apis.html#ga8160f563678d1f39b84bb7d30033b824">XNVM_BBRAM_AES_KEY_STR_LEN</a>&#160;&#160;&#160;(<a class="el" href="group__xnvm__apis.html#ga1549af470b2278bd56555178fa8622b5">XNVM_BBRAM_AES_KEY_LEN_IN_BITS</a> / 4U)</td></tr>
<tr class="memdesc:ga8160f563678d1f39b84bb7d30033b824"><td class="mdescLeft">&#160;</td><td class="mdescRight">String length of Key.  <a href="#ga8160f563678d1f39b84bb7d30033b824">More...</a><br/></td></tr>
<tr class="separator:ga8160f563678d1f39b84bb7d30033b824"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3bea3a3b68aa8115170a9f88ee04baf7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__apis.html#ga3bea3a3b68aa8115170a9f88ee04baf7">XNVM_MAX_SLR_NUM</a>&#160;&#160;&#160;<a class="el" href="group__xnvm__efuse__client__apis.html#gae83bff3d807531eee2767b16d00a54f4">XNVM_SLR_INDEX_3</a></td></tr>
<tr class="memdesc:ga3bea3a3b68aa8115170a9f88ee04baf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Max SLR number.  <a href="#ga3bea3a3b68aa8115170a9f88ee04baf7">More...</a><br/></td></tr>
<tr class="separator:ga3bea3a3b68aa8115170a9f88ee04baf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1549af470b2278bd56555178fa8622b5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__apis.html#ga1549af470b2278bd56555178fa8622b5">XNVM_BBRAM_AES_KEY_LEN_IN_BITS</a>&#160;&#160;&#160;(256U)</td></tr>
<tr class="memdesc:ga1549af470b2278bd56555178fa8622b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">AES key length in Bits.  <a href="#ga1549af470b2278bd56555178fa8622b5">More...</a><br/></td></tr>
<tr class="separator:ga1549af470b2278bd56555178fa8622b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga063185be808d423aa306a8ab64e793e5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__apis.html#ga063185be808d423aa306a8ab64e793e5">XNVM_BBRAM_AES_KEY_LEN_IN_BYTES</a>&#160;&#160;&#160;(<a class="el" href="group__xnvm__apis.html#ga1549af470b2278bd56555178fa8622b5">XNVM_BBRAM_AES_KEY_LEN_IN_BITS</a> / 8U)</td></tr>
<tr class="memdesc:ga063185be808d423aa306a8ab64e793e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">AES key length in Bytes.  <a href="#ga063185be808d423aa306a8ab64e793e5">More...</a><br/></td></tr>
<tr class="separator:ga063185be808d423aa306a8ab64e793e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8160f563678d1f39b84bb7d30033b824"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__apis.html#ga8160f563678d1f39b84bb7d30033b824">XNVM_BBRAM_AES_KEY_STR_LEN</a>&#160;&#160;&#160;(<a class="el" href="group__xnvm__apis.html#ga1549af470b2278bd56555178fa8622b5">XNVM_BBRAM_AES_KEY_LEN_IN_BITS</a> / 4U)</td></tr>
<tr class="memdesc:ga8160f563678d1f39b84bb7d30033b824"><td class="mdescLeft">&#160;</td><td class="mdescRight">String length of Key.  <a href="#ga8160f563678d1f39b84bb7d30033b824">More...</a><br/></td></tr>
<tr class="separator:ga8160f563678d1f39b84bb7d30033b824"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__apis.html#ga840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:ga840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the function to provision Configuration limiter parameters.  <a href="#ga840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:ga840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga1549af470b2278bd56555178fa8622b5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XNVM_BBRAM_AES_KEY_LEN_IN_BITS&#160;&#160;&#160;(256U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>AES key length in Bits. </p>

</div>
</div>
<a class="anchor" id="ga1549af470b2278bd56555178fa8622b5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XNVM_BBRAM_AES_KEY_LEN_IN_BITS&#160;&#160;&#160;(256U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>AES key length in Bits. </p>

</div>
</div>
<a class="anchor" id="ga1549af470b2278bd56555178fa8622b5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XNVM_BBRAM_AES_KEY_LEN_IN_BITS&#160;&#160;&#160;(256U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>AES key length in Bits. </p>

</div>
</div>
<a class="anchor" id="ga063185be808d423aa306a8ab64e793e5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XNVM_BBRAM_AES_KEY_LEN_IN_BYTES&#160;&#160;&#160;(<a class="el" href="group__xnvm__apis.html#ga1549af470b2278bd56555178fa8622b5">XNVM_BBRAM_AES_KEY_LEN_IN_BITS</a> / 8U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>AES key length in Bytes. </p>

</div>
</div>
<a class="anchor" id="ga063185be808d423aa306a8ab64e793e5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XNVM_BBRAM_AES_KEY_LEN_IN_BYTES&#160;&#160;&#160;(<a class="el" href="group__xnvm__apis.html#ga1549af470b2278bd56555178fa8622b5">XNVM_BBRAM_AES_KEY_LEN_IN_BITS</a> / 8U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>AES key length in Bytes. </p>

</div>
</div>
<a class="anchor" id="ga063185be808d423aa306a8ab64e793e5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XNVM_BBRAM_AES_KEY_LEN_IN_BYTES&#160;&#160;&#160;(<a class="el" href="group__xnvm__apis.html#ga1549af470b2278bd56555178fa8622b5">XNVM_BBRAM_AES_KEY_LEN_IN_BITS</a> / 8U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>AES key length in Bytes. </p>

</div>
</div>
<a class="anchor" id="ga8160f563678d1f39b84bb7d30033b824"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XNVM_BBRAM_AES_KEY_STR_LEN&#160;&#160;&#160;(<a class="el" href="group__xnvm__apis.html#ga1549af470b2278bd56555178fa8622b5">XNVM_BBRAM_AES_KEY_LEN_IN_BITS</a> / 4U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>String length of Key. </p>

</div>
</div>
<a class="anchor" id="ga8160f563678d1f39b84bb7d30033b824"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XNVM_BBRAM_AES_KEY_STR_LEN&#160;&#160;&#160;(<a class="el" href="group__xnvm__apis.html#ga1549af470b2278bd56555178fa8622b5">XNVM_BBRAM_AES_KEY_LEN_IN_BITS</a> / 4U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>String length of Key. </p>

</div>
</div>
<a class="anchor" id="ga8160f563678d1f39b84bb7d30033b824"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XNVM_BBRAM_AES_KEY_STR_LEN&#160;&#160;&#160;(<a class="el" href="group__xnvm__apis.html#ga1549af470b2278bd56555178fa8622b5">XNVM_BBRAM_AES_KEY_LEN_IN_BITS</a> / 4U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>String length of Key. </p>

</div>
</div>
<a class="anchor" id="ga3bea3a3b68aa8115170a9f88ee04baf7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XNVM_MAX_SLR_NUM&#160;&#160;&#160;<a class="el" href="group__xnvm__efuse__client__apis.html#gae83bff3d807531eee2767b16d00a54f4">XNVM_SLR_INDEX_3</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Max SLR number. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the function to provision Configuration limiter parameters. </p>
<p>Main function to call the Bbram AES key write example function.</p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_FAILURE if the BBRAM programming failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>By default PLM does not include the NVM client code, it is disabled by a macro PLM_NVM_EXCLUDE. So, to run this client application successfully we need to enable NVM code in PLM before executing this application.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_FAILURE if the BBRAM programming failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="group__xnvm__mailbox__apis.html#ga051799e29b90346a34e49e8fddfc10e5">XNvm_ClientInit()</a>, and <a class="el" href="group__xnvm__bbram__client__api.html#ga3b6228f47fedbf81e4a4d428a59f2ed4">XNVM_SLR_INDEX_0</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
